FeePaidandLodged

This operation transfers fee paid and lodged status from the agency's IT system to the online state DA digital service.

path Parameters
CaseID
required
string

A fully qualified application number

header Parameters
OrganisationID
required
string

Used by the API gateway to identify the agency from which the request was initiated.

IdempotencyID
required
string

Unique Id for this request. Allows the API to respond in an idempotent way if it has already been called with these parameters and prevents duplicate processing. Typically a UUID such as "63a9ba30-7a4b-4fac-b343-d1f05cf089f1"

Request Body schema: application/json
isFeesPaid
required
boolean

This is to track whether the applicant had paid the fee or not.

isFeePayableunderPart13
boolean

This is to track the lodgement date. This gives the ability to mark a modification State DA as lodged on the day the application was submitted if no fee is payable under Part 13, so that the applicant is notified about correct lodgement date and process.

totalFeesPaid
number

This is to track the total amount paid. Mandatory when isFeesPaid is 'true'.

invoiceNumber
string <= 20 characters

This is to track the invoice number. Applicable when isFeesPaid is 'true'.

paymentDate
string <date>

This is to track the payment date. Applicable if isFeesPaid is 'true'.

consentAuthorityID
string <= 20 characters

This is to track the internal application ID generated in the agency's IT system.

acceptDate
string <date>

This is to track the date application was accepted in the agency's IT system. This field will be read only if paymentDate contains any valid value.

Array of objects (DownloadableDocument)
updatedByEmail
required
string <= 250 characters

User must be registered in the planning portal.

Responses

Request samples

Content type
application/json
{
  • "isFeesPaid": true,
  • "isFeePayableunderPart13": true,
  • "totalFeesPaid": 1250.9,
  • "invoiceNumber": "string",
  • "paymentDate": "2019-08-24",
  • "consentAuthorityID": "string",
  • "acceptDate": "2019-08-24",
  • "Documents": [
    ],
  • "updatedByEmail": "john.smith@gmail.com"
}